home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1996 March / EnigmA AMIGA RUN 05 (1996)(G.R. Edizioni)(IT)[!][issue 1996-03][Skylink CD IV].iso / earcd / games1 / tttw.lha / C / ppmore.doc.pp / ppmore.doc
Text File  |  1991-07-29  |  11KB  |  267 lines
  1.  
  2.  
  3.                            PPMore 1.5 User Manual
  4.  
  5.                                 Dec 17, 1989
  6.  
  7.  
  8.  
  9. Preface
  10. =======
  11.  
  12.      This program is freeware, this means that you can copy it freely as long
  13. as you don't ask any more money for it than a nominal fee for copying.  If
  14. you want to distribute this program you should keep this document with it.
  15.      If you have suggestions or remarks about this program, or if you find
  16. any bugs, please let me know.
  17.  
  18.      Write to the following address:
  19.  
  20.                                 Nico François
  21.                                 Corbielaan 13
  22.                              3060 Bertem BELGIUM
  23.  
  24.  
  25. Contents
  26. ========
  27.  
  28. 1. An introduction
  29.  
  30. 2. Usage
  31.  
  32. 3. Control
  33.  
  34. 4. Using PPMore from other programs
  35.  
  36.  
  37. 1. An introduction
  38. ==================
  39.  
  40.      This program was written to complement one of my other utilities,
  41. PowerPacker (a command and data cruncher).  It is used to read normal ascii
  42. text files or text files crunched with PowerPacker.  The program itself is
  43. about 10K long and when you know you save about 60% when you crunch a text
  44. file, you can see that this could save a lot of space on your disks.
  45.      PPMore was written as a more replacement (as you could have guessed :-),
  46. so I tried to keep the keyboard commands the same as well as adding some new.
  47. There are two main differences between PPMore and More, PPMore uses gadgets
  48. and it always loads the complete file in memory (More only loads part of the
  49. file and will load the rest when needed).  If you can live with these
  50. differences, you can replace More with PPMore anywhere you want.
  51.      If you haven't got PowerPacker you are of course missing the main
  52. feature of this program.  You can try to find it in your favourite public
  53. domain library or you can get it by writing to my address and adding $15 US
  54. (if you live in Europe), $20 US (if you live elsewhere).  Send money in
  55. cash (bit risky though), by international money order or by EuroCheck (only
  56. in Belgian Francs (BF) !!!!) (Please don't send other checks).  PowerPacker
  57. was published in the November 89 issue of JumpDisk and can be found on one of
  58. the Antares RD or Fish disks.
  59.  
  60.  
  61. 2. Usage
  62. ========
  63.  
  64.      PPMore can be used in three different ways.
  65.  
  66. - First of all via the CLI:
  67.  
  68.      If you enter PPMore without arguments you will get a usage template.
  69. You use PPMore like this:
  70.  
  71.      PPMore [<options>] <filename>
  72.  
  73.      The program will then load the ascii file and display it.  If the file
  74. was crunched using PowerPacker 2.0 or higher PPMore will first decrunch it
  75. for you.  If the file was encrypted you will be prompted for the password.
  76.      The options are explained in section 4.
  77.      PPMore can be made resident so it doesn't have to be loaded every time
  78. you use it, use the ARP ARes command or the WB1.3 Resident command for this.
  79. You can't make PPMore resident when it is crunched !!  The file is supplied
  80. as an uncrunched command file with the pure bit set.
  81.      If you enter PPMore without options, you will be presented with either a
  82. file prompt or the ARP filerequester (if arp.library is available).
  83.      Enter 'PPMore ?' for a little usage message.
  84.  
  85. - Via the WorkBench:
  86.  
  87.      There are three different ways of using PPMore via the workbench: you
  88. can set the default tool of the (crunched) text file to 'PPMore', you can
  89. single click the PPMore icon and then double click the text file icon or you
  90. can double-click the PPMore icon and enter the filename in the string gadget
  91. (or the ARP filerequester) you will be presented with.
  92.      You set the default tool by single clicking the icon of the text file
  93. and selecting 'Info' from the workbench menu.  You will get a window with
  94. several gadgets in it, click in the string gadget where it says 'Default
  95. tool' and enter ':ppmore'.  PPMore should be in the root directory of your
  96. disk for this to work, if e.g. it's in the system directory you should enter
  97. ':system/ppmore'.  Last of all select the 'Save' gadget.
  98.  
  99. NOTE: - PPMore will add '.pp' to the filename when the file wasn't found.
  100.         This is very useful in the WorkBench enviroment: you can make an
  101.         icon for 'text.doc' but name the file 'text.doc.pp'.  Now the
  102.         WorkBench will show an icon with 'text.doc' as name, but if you
  103.         doubleclick it 'text.doc.pp' will be displayed.  (As long as there
  104.         is no 'text.doc' file in the directory !)
  105.       - Once you are in PPMore press 'L' to load a new file, this is
  106.         especially useful if the arp.library is available.
  107.  
  108.  
  109. 3. Control
  110. ==========
  111.  
  112.      PPMore can be controlled by keyboard or by intuition gadgets.  To get a
  113. summary of the keyboard commands press <HELP>, the function of the gadgets
  114. shouldn't be hard to understand.
  115.      A few notes on printing:
  116.  
  117. - The printer.device has to be in the devs: directory for PPMore to be able
  118.   to print, you should also have a correct system-configuration for your
  119.   printer.
  120.  
  121. - You can continue to read the text when PPMore is printing (this IS a
  122.   multitasking computer ! :-), you can't quit when printing is still in
  123.   progress !
  124.  
  125.  
  126. 4. Using PPMore from other programs
  127. ===================================
  128.  
  129.      If you are not a programmer you can skip this section.
  130.  
  131.      PPMore 1.5 has two power options to make it possible to use PPMore from
  132. other programs.  This way you don't have to include a text displayer in
  133. your programs, you just execute PPMore with one (or all) of the following
  134. options:
  135.  
  136.      -@mem,len,flags[,name]
  137.  
  138.        If you specify this option PPMore will not load a file but instead it
  139.      will display a chunk of memory.  You specify the memory addres and
  140.      length in the command line as well as some flags.  The current version
  141.      only has one flag: PPMORE_FREEMEM = bit 0 of the flag-word = 0x1.
  142.        When this flag is set PPMore will free the memory after it has
  143.      finished, if it isn't set PPMore will just exit and leave the memory
  144.      alone.  This way your program can start PPMore with the PPMORE_FREEMEM
  145.      flag set and exit before PPMore has ended.  PPMore will then free the
  146.      memory instead of your program.
  147.           The address, length and flags must be presented as HEX longwords
  148.      seperated by a comma.  These options can be followed by another comma
  149.      and a string to give the memory chunk a name, if this string is omited
  150.      PPMore will use the name 'memory'.  This string ends with the end of the
  151.      command line so it can contain spaces.
  152.  
  153.      -Sscreen or -S*
  154.  
  155.        With this option you can use PPMore on another screen.  You must
  156.      provide a screen address in HEX.  PPMore will the open the main window
  157.      on this screen.  If you specify a '*' instead of a screen address the
  158.      frontmost screen will be used.
  159.  
  160.      Examples:
  161.  
  162.        o  PPMore -@1A000,1D4E,0,my chunk
  163.  
  164.             PPMore will open a window 'Listing of my chunk', start
  165.           displaying at address 0x1A000 and stop at address 0x1BD4E.  The
  166.           memory will not be freed after PPMore exits.
  167.  
  168.        o  PPMore -Sc2d8a0 -@1A000,1D4E,1,my chunk
  169.  
  170.             Same as previous but now PPMore will free the memory chunk and
  171.           open the main window on the custom screen with the screen structure
  172.           on address 0xc2d8a0.
  173.  
  174.        o  PPMore -S* myfile
  175.  
  176.             Load and display the file 'myfile' and open window on the front
  177.           screen.
  178.  
  179. NOTE: - The options are case sensitive.
  180.       - The @ option must always be the last option on the command line.
  181.       - If you open PPMore on another screen PPMore will not check if the
  182.         screen closes !!  PPMore should always finish before this screen is
  183.         closed !
  184.       - I advise you to use the ARP 1.3 SyncRun and/or ASyncRun instead of
  185.         the AmigaDOS Execute function to execute PPMore from your programs
  186.         because the ARP functions also work when your program has been
  187.         started from WorkBench.
  188.       - Watch out when using this options, it is very easy to crash the Amiga
  189.         when you don't know what you are doing !!!
  190.  
  191.  
  192.                       As always, I hope you find this program useful !
  193.  
  194.  
  195.                               PROGRAM HISTORY:
  196.  
  197. *****************************************************************************
  198. VERSION 1.0
  199.  
  200.      First release.
  201.  
  202. *****************************************************************************
  203. VERSION 1.1
  204.  
  205.      '.pp' suffix added to filename when file not found, very useful in
  206.        WorkBench enviroment.
  207.      PPMore now also loads encrypted files. (PowerPacker 2.3a or higher)
  208.  
  209. *****************************************************************************
  210. VERSION 1.2
  211.  
  212.      Rewritten some routines in assembler, results in a slightly faster
  213.        and smaller PPMore.
  214.      Keyboard input improved. Autorepeat of keys is ignored so you can keep
  215.        on pressing <page down> without typing it 20 times ahead !
  216.      Gadget input also improved, now handles repeat.
  217.      PPMore now prompts for a filename when double-clicked from WorkBench.
  218.  
  219. *****************************************************************************
  220. VERSION 1.3
  221.  
  222.      PPMore can now be made resident and is reentrant. (provided PPMore is
  223.        not crunched)
  224.      Improved error reporting, the main window only opens when PPMore is
  225.        going to display the file.
  226.      File is checked to see if it is an ASCII (text) file.
  227.      Two new power-options for use of PPMore from other programs:
  228.        -@ to display memory, -S to open window on a custom screen.
  229.      Fast assembler search function added.
  230.      Display position is displayed in titlebar (percentage).
  231.      Goto n% function added, replaced 'Refresh' gadget with this function.
  232.      Decrunching is 15% faster.
  233.      'Exit PPMore' only selected when button is released on top of gadget.
  234.      NO bugs removed because none where found. :-)
  235.      Only about 700 bytes larger than version 1.2 !
  236.  
  237. *****************************************************************************
  238. VERSION 1.4
  239.  
  240.      Bug fixed: PPMore 1.3 was not 100% pure, version 1.4 is !
  241.      ASCII check less strict (e.g. now allows files to contain a '©')
  242.      Another 300 bytes shorter than version 1.3 :-)
  243.  
  244. *****************************************************************************
  245. VERSION 1.5
  246.  
  247.      Bug fixed: search/goto window always opened on WorkBench screen.
  248.      Find previous also implemented.
  249.      Load a new file from within PPMore.
  250.      PPMore uses ARP file requester if arp.library is available.
  251.      Line count, as well as goto line.
  252.      Display position as percentage or line number.
  253.      Keypad = movement. (for PC-lovers, yek :-( )
  254.      PPMore now supports all keymaps !! I think especially german and french
  255.        Amiga users will be grateful for this.
  256.      Less than 600 bytes longer than version 1.4 (I love this :-D)
  257.  
  258. *****************************************************************************
  259.  
  260. PPMore 1.5 written by Nico François (Yes, Nico is my first name :-)
  261.  
  262. (c) 1989 Nico François / PowerPeak
  263.  
  264.                                    //
  265.                        Thanks to \X/ Amiga for being the best computer ever !
  266.  
  267.